/*
 * Yguan - Yui Gwt Unified ANimation
 *
 * Copyright (c) 2009, Yves Cuillerdier
 * All rights reserved.
 * 
 * This software is licensed under the new BSD License:
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, 
 * this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the documentation 
 * and/or other materials provided with the distribution.
 * 
 * Neither the name of the author nor the names of its contributors may 
 * be used to endorse or promote products derived from this software without 
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * @version 0.1.0
 */
package gyraf.core.client.animation;

import com.google.gwt.core.client.JavaScriptObject;

/**
 * Determines how an animation proceeds from start to end.
 * <p>
 * These enums wraps the so called "easing" YUI objects.
 * <p>
 * See animation.js file for Licensing informations about the EASINGS EQUATIONS
 */
public enum AnimationEffect {

	/**
	 * Uniform speed between points.
	 */
	easeNone,

	/**
	 * Begins slowly and accelerates towards end.
	 */
	easeIn,

	/**
	 * Begins quickly and decelerates towards end.
	 */
	easeOut,

	/**
	 * Begins slowly and decelerates towards end.
	 */
	easeBoth,

	/**
	 * Begins slowly and accelerates towards end.
	 */
	easeInStrong,

	/**
	 * Begins quickly and decelerates towards end.
	 */
	easeOutStrong,

	/**
	 * Begins slowly and decelerates towards end.
	 */
	easeBothStrong,

	/**
	 * Snap in elastic effect.
	 */
	elasticIn,

	/**
	 * Snap out elastic effect.
	 */
	elasticOut,

	/**
	 * Snap both elastic effect.
	 */
	elasticBoth,

	/**
	 * Backtracks slightly, then reverses direction and moves to end.
	 */
	backIn,

	/**
	 * Overshoots end, then reverses and comes back to end.
	 */
	backOut,

	/**
	 * Backtracks slightly, then reverses direction, overshoots end, then
	 * reverses and comes back to end.
	 */
	backBoth,

	/**
	 * Bounce off of start.
	 */
	bounceIn,

	/**
	 * Bounces off end.
	 */
	bounceOut,

	/**
	 * Bounces off start and end.
	 */
	bounceBoth,

	;

	private JavaScriptObject element;

	private AnimationEffect() {
		element = getJSObject(name());
		// check method exists on creation
		if (element == null) {
			throw new RuntimeException("The easing " + this.name()
					+ " was not found in YAHOO.util.Easing.");
		}
	}

	/**
	 * @return the Easing function
	 */
	public JavaScriptObject getJsElement() {
		return element;
	}

	private static native JavaScriptObject getJSObject(String name) /*-{
	  		return $wnd.YAHOO.util.Easing[name];
	}-*/;

	/**
	 * Return the Easing with the given name.
	 * 
	 * @param name
	 *            the Easing name
	 * @return the Easing for the given name
	 */
	public static AnimationEffect get(final String name) {
		try {
			return Enum.valueOf(AnimationEffect.class, name);
		} catch (final Exception e) {
			return null;
		}
	}
}
